/*
 * unsafe_swift_compat.h
 *
 * This source file is part of the FoundationDB open source project
 *
 * Copyright 2013-2024 Apple Inc. and the FoundationDB project authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef FLOW_UNSAFE_SWIFT_COMPAT_H
#define FLOW_UNSAFE_SWIFT_COMPAT_H

/// This is an unsafe annotation that bridges C++ types as immortal class types in Swift.
///
/// Please take extreme care when applying this annotation to C++ types, as this annotation
/// can lead to use-after-frees or memory leaks very easily.
#define UNSAFE_SWIFT_CXX_IMMORTAL_REF                                                                                  \
	__attribute__((swift_attr("import_reference"))) __attribute__((swift_attr("retain:immortal")))                     \
	__attribute__((swift_attr("release:immortal")))

#endif // FLOW_UNSAFE_SWIFT_COMPAT_H
